<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
	<title>oak-security-audit: openark kit documentation</title>
	<meta name="description" content="oak-security-audit: openark kit" />
	<meta name="keywords" content="oak-security-audit: openark kit" />
	<link rel="stylesheet" type="text/css" href="style.css" />
</head>

<body>
	<div id="main">
		<div id="header">
			<h1>openark kit documentation</h1>
			<div class="subtitle">Common utilities for MySQL</div>
		</div>
		<div id="contentwrapper">
			<div id="content">
				<h2><a href="oak-security-audit.html">oak-security-audit</a></h2>	
<h3>NAME</h3>
oak-security-audit: audit accounts, passwords, privileges and other
security settings.
<h3>SYNOPSIS</h3>
Perform a strict audit:
<blockquote>oak-security-audit</blockquote>
Perform a strict audit (explicit):
<blockquote>oak-security-audit --audit-level=strict</blockquote>
Perform a strict audit (explicit), handle the users 'my_admin' and
'my_assistant' as if they were 'root':
<blockquote>oak-security-audit --audit-level=strict
--assume-root=my_admin,my_assistant</blockquote>
Perform a normal level (more relaxed) audit:
<blockquote>oak-security-audit --audit-level=normal</blockquote>
Same as above, provide connection parameters, prompt for password:
<blockquote>oak-security-audit --user=root --ask-pass
--socket=/tmp/mysql.sock -l normal</blockquote>
Same as above, use defaults file:
<blockquote>oak-security-audit
--defaults-file=/home/myuser/.my-oak.cnf -l normal</blockquote>
<h3>DESCRIPTION</h3>
oak-security-audit connects to a MySQL instance and performs
comprehensive security tests. Tests are performed on the following
subjects:
<ul>
	<li>Accounts</li>
	<li>Passwords</li>
	<li>Privileges</li>
	<li>General</li>
</ul>
The utility prints a detailed report which lists the tests, the result
of each test, and recommendations. Recommendations may vary from
specific queries to be executed, to general guidelines for
consideration. The utility does not modify data or performs any of its
recommendations. It is up to the user to decide if and how to act. The
following audits are performed:
<ul>
	<li>Accounts
	<ul>
		<li>Check for non-local root accounts</li>
		<li>Check for anonymous users</li>
		<li>Check for wildcard host accounts</li>
	</ul>
	</li>
	<li>Passwords
	<ul>
		<li>Look for accounts with empty passwords (implies no password
		required)</li>
		<li>Look for different users sharing the same password</li>
	</ul>
	</li>
	<li>Privileges
	<ul>
		<li>Report non-root accounts with all grants</li>
		<li>Report non-root accounts with administrative privileges (e.g.
		SUPER, SHUTDOWN)</li>
		<li>Report non-root accounts with powerful modification
		privileges (e.g. DROP, ALTER)</li>
		<li>Report non-root accounts with data manipulation privileges on
		all schemata</li>
		<li>Report non-root accounts with write access to the `mysql`
		schema</li>
	</ul>
	</li>
	<li>General
	<ul>
		<li>Check the security related sql_mode</li>
		<li>See if old passwords are used</li>
		<li>See if networking is enabled</li>
		<li>See if the `test` schema exists</li>
	</ul>
	</li>
</ul>
If --assume-root is used, then in addition to user 'root', all listed
users are handled in the same way as 'root'. This means some tests will
be more restrictive on those users, and some more permissive.
<h3>OPTIONS</h3>
--ask-pass
<p class="indent">Prompt for password.</p>

-r ASSUME_ROOT, --assume-root=ASSUME_ROOT
<p class="indent">Comma seperated list of users which
are to be treated as 'root'</p>

--defaults-file=DEFAULTS_FILE
<p class="indent">Read from MySQL configuration file. Overrides --user, --password, --socket, --port.</p>
<p class="indent">Configuration needs to be in the following format:</p>

<p class="indent"><strong>[client]<br/>
user=my_user<br/>
password=my_pass<br/>
socket=/tmp/mysql.sock<br/>
port=3306</strong>
</p>

-H HOST, --host=HOST
<p class="indent">MySQL host (default: localhost)</p>
-p PASSWORD, --password=PASSWORD
<p class="indent">MySQL password</p>

-P PORT, --port=PORT
<p class="indent">TCP/IP port (default: 3306)</p>

-S SOCKET, --socket=SOCKET
<p class="indent">MySQL socket file. Only applies when
host is localhost</p>

-u USER, --user=USER
<p class="indent">MySQL user</p>

<h3>ENVIRONMENT</h3>
Requires MySQL 5.0 or newer, python 2.3 or newer. python-mysqldb must be
installed in order to use this tool. You can
<blockquote>apt-get install python-mysqldb</blockquote>
or
<blockquote>yum install mysql-python</blockquote>
<h3>SEE ALSO</h3>
<p>oak-block-account</p>

<h3>LICENSE</h3>
This tool is released under the BSD license.
<blockquote><pre>Copyright (c) 2008 - 2010, Shlomi Noach
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
* Neither the name of the organization nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR 
TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</pre>
</blockquote>
<h3>AUTHOR</h3>
Shlomi Noach
				<br/>
			</div>
			<div id="sidebarwrapper">
				<div id="menu">
					<h3>openark kit tools</h3>
					<ul>
						<li><a title="Introduction" href="introduction.html">Introduction</a></li>
						<li><a title="Download" href="download.html">Download</a></li>
						<li><a title="Install" href="install.html">Install</a></li>
						<li><a title="oak-apply-ri" href="oak-apply-ri.html">oak-apply-ri</a></li>
						<li><a title="oak-block-account" href="oak-block-account.html">oak-block-account</a></li>
						<li><a title="oak-chunk-update" href="oak-chunk-update.html">oak-chunk-update</a></li>
						<li><a title="oak-get-slave-lag" href="oak-get-slave-lag.html">oak-get-slave-lag</a></li>
						<li><a title="oak-hook-general-log" href="oak-hook-general-log.html">oak-hook-general-log</a></li>
						<li><a title="oak-kill-slow-queries" href="oak-kill-slow-queries.html">oak-kill-slow-queries</a></li>
						<li><a title="oak-modify-charset" href="oak-modify-charset.html">oak-modify-charset</a></li>
						<li><a title="oak-online-alter-table" href="oak-online-alter-table.html">oak-online-alter-table</a></li>
						<li><a title="oak-prepare-shutdown" href="oak-prepare-shutdown.html">oak-prepare-shutdown</a></li>
						<li><a title="oak-purge-master-logs" href="oak-purge-master-logs.html">oak-purge-master-logs</a></li>
						<li><a title="oak-repeat-query" href="oak-repeat-query.html">oak-repeat-query</a></li>
						<li><a title="oak-security-audit" href="oak-security-audit.html">oak-security-audit</a></li>
						<li><a title="oak-show-limits" href="oak-show-limits.html">oak-show-limits</a></li>
						<li><a title="oak-show-replication-status" href="oak-show-replication-status.html">oak-show-replication-status</a></li>
					</ul>
				</div>
			</div>	
			<div class="clear">&nbsp;</div>
			
			<div id="footnote" align="center">
				<a href="">openark kit</a> documentation
			</div>
		</div>
	</div>
</body>
</html>
